Documenting a component

Once you have created a new component, document the component so that other users can install and use it.

1. Click Designer Studio > Application > Components.

2. Select the component that you want to document.

3. Click the Documentation tab.

4. Optional: Upload an icon to associate with this component.

   Note: The icon file must be a .png, .jpg, or a .bmp file. The icon file size must be 3 MB or smaller. The icon must be exactly 120 pixels high and 120 pixels wide.

   1. In the Overview section, click Upload icon.

   2. Click Choose File.

   3. Select the icon file, and click Open.

   4. Click Submit.

5. Optional: Enter a Description of the component.

6. Optional: In the Key features section, enter a key feature of the component to help users understand what it does. Click Add new to add additional features.

7. Optional: Upload a PDF file with information about this component.

   Note: You can only upload a PDF file with a maximum size of 25 MB.

   1. Optional: Click download template to download a documentation template. Click download example to see a sample installation guide.
   2. Click Upload.

   3. Click Choose File.

   4. Select the file you want to add, and click Open.

   5. Click Submit.

8. Click Save.

Open topic with navigation